Fix some optional config file boolean options not being honored #188
Conversation
Boolean CLI options with defaults (keepComments, sortComponentsProps, split) were not being respected when set in a config file. This happened because Commander.js always sets these options to their default values, and the subsequent Object.assign would overwrite config file values with CLI defaults. The fix applies the same pattern already used for lineWidth, sort, and bundle: explicitly check for config file values before the merge, using nullish coalescing to preserve CLI-specified values when present. Co-Authored-By: Claude Opus 4.5 <[email protected]>
jdechicchis
force-pushed
the
fix/config-file-boolean-options
branch
from
67f88a7 to
f04cd0e
Compare
| exports[`openapi-format CLI command should respect boolean options from .openapiformatrc 1`] = ` | ||
| "================================================================================ | ||
| OpenAPI-Format CLI settings: | ||
| - .openapiformatrc: /Users/joseph/oss/openapi-format/.openapiformatrc |
There was a problem hiding this comment.
Can you rework this, since it should not snapshot your local user path.
|
hi @jdechicchis Nice that you spotted this. The test runs spotted a small issue with your local user ending up in the snapshot: If you correct this, the PR will be included in the next release. |
|
Hi @jdechicchis I merged in your PR and fixed the test, which was a side-effect of the test suite itself. Your PR will be part of the of the next release and thanks again for contributing and using openapi-format 🤝 |
|
FYi @jdechicchis |
|
@thim81 appreciate you making the fix and merging this! |
2 participants
I noticed that the
keepCommentsoption wasn't being honored when passing a config file like:openapi-format api.yaml -o api.yaml --configFile .openapi-format.json..openapi-format.jsoncontents:Passing the option as a CLI flag worked as expected:
openapi-format api.yaml -o api.yaml --keepComments.Upon some investigation, it appears the source of the bug is with how CLI flags with default values are handled in
bin/cli.js. It looks like there was already special handling for flags likelineWidthandsort. This PR adds similar handling forkeepComments,sortComponentsProps, andsplitNote, this fix could result in the format output differing once folks upgrade their
openapi-formatversion if their current formatting "relied" on these options not being honored when configured via a config file